<!DOCTYPE html>

















































<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  <meta name="description" content="Javadoc API documentation for MyBatis Generator Core." />

<link rel="shortcut icon" type="image/x-icon" href="../../../../favicon.ico" />
<title>

  CommentGenerator


| MyBatis Generator Core

</title>
<link href="../../../../../assets/doclava-developer-docs.css" rel="stylesheet" type="text/css" />
<link href="../../../../../assets/customizations.css" rel="stylesheet" type="text/css" />
<script src="../../../../../assets/search_autocomplete.js" type="text/javascript"></script>
<script src="../../../../../assets/jquery-resizable.min.js" type="text/javascript"></script>
<script src="../../../../../assets/doclava-developer-docs.js" type="text/javascript"></script>
<script src="../../../../../assets/prettify.js" type="text/javascript"></script>
<script type="text/javascript">
  setToRoot("../../../../", "../../../../../assets/");
</script>
<script src="../../../../../assets/doclava-developer-reference.js" type="text/javascript"></script>
<script src="../../../../../assets/navtree_data.js" type="text/javascript"></script>
<script src="../../../../../assets/customizations.js" type="text/javascript"></script>
<noscript>
  <style type="text/css">
    html,body{overflow:auto;}
    #body-content{position:relative; top:0;}
    #doc-content{overflow:visible;border-left:3px solid #666;}
    #side-nav{padding:0;}
    #side-nav .toggle-list ul {display:block;}
    #resize-packages-nav{border-bottom:3px solid #666;}
  </style>
</noscript>
</head>

<body class="">

<div id="header">
    <div id="headerLeft">
    
      <span id="masthead-title">MyBatis Generator Core</span>
    
    </div>
    <div id="headerRight">
      
  <div id="search" >
      <div id="searchForm">
          <form accept-charset="utf-8" class="gsc-search-box" 
                onsubmit="return submit_search()">
            <table class="gsc-search-box" cellpadding="0" cellspacing="0"><tbody>
                <tr>
                  <td class="gsc-input">
                    <input id="search_autocomplete" class="gsc-input" type="text" size="33" autocomplete="off"
                      title="search developer docs" name="q"
                      value="search developer docs"
                      onFocus="search_focus_changed(this, true)"
                      onBlur="search_focus_changed(this, false)"
                      onkeydown="return search_changed(event, true, '../../../../')"
                      onkeyup="return search_changed(event, false, '../../../../')" />
                  <div id="search_filtered_div" class="no-display">
                      <table id="search_filtered" cellspacing=0>
                      </table>
                  </div>
                  </td>
                  <td class="gsc-search-button">
                    <input type="submit" value="Search" title="search" id="search-button" class="gsc-search-button" />
                  </td>
                  <td class="gsc-clear-button">
                    <div title="clear results" class="gsc-clear-button">&nbsp;</div>
                  </td>
                </tr></tbody>
              </table>
          </form>
      </div><!-- searchForm -->
  </div><!-- search -->
      
    </div>
</div><!-- header -->


  <div class="g-section g-tpl-240" id="body-content">
    <div class="g-unit g-first side-nav-resizable" id="side-nav">
      <div id="swapper">
        <div id="nav-panels">
          <div id="resize-packages-nav">
            <div id="packages-nav">
              <div id="index-links">
                <a href="../../../../packages.html"  >Package Index</a> | 
                <a href="../../../../classes.html" >Class Index</a>
              </div>
              <ul>
                
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/ant/package-summary.html">org.mybatis.generator.ant</a></li>
    <li class="selected api apilevel-">
  <a href="../../../../org/mybatis/generator/api/package-summary.html">org.mybatis.generator.api</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/api/dom/package-summary.html">org.mybatis.generator.api.dom</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/api/dom/java/package-summary.html">org.mybatis.generator.api.dom.java</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/api/dom/xml/package-summary.html">org.mybatis.generator.api.dom.xml</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/package-summary.html">org.mybatis.generator.codegen</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/package-summary.html">org.mybatis.generator.codegen.ibatis2</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/dao/package-summary.html">org.mybatis.generator.codegen.ibatis2.dao</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/dao/elements/package-summary.html">org.mybatis.generator.codegen.ibatis2.dao.elements</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/dao/templates/package-summary.html">org.mybatis.generator.codegen.ibatis2.dao.templates</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/model/package-summary.html">org.mybatis.generator.codegen.ibatis2.model</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/sqlmap/package-summary.html">org.mybatis.generator.codegen.ibatis2.sqlmap</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/ibatis2/sqlmap/elements/package-summary.html">org.mybatis.generator.codegen.ibatis2.sqlmap.elements</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/package-summary.html">org.mybatis.generator.codegen.mybatis3</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/javamapper/package-summary.html">org.mybatis.generator.codegen.mybatis3.javamapper</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/javamapper/elements/package-summary.html">org.mybatis.generator.codegen.mybatis3.javamapper.elements</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/javamapper/elements/annotated/package-summary.html">org.mybatis.generator.codegen.mybatis3.javamapper.elements.annotated</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/javamapper/elements/sqlprovider/package-summary.html">org.mybatis.generator.codegen.mybatis3.javamapper.elements.sqlprovider</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/model/package-summary.html">org.mybatis.generator.codegen.mybatis3.model</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/xmlmapper/package-summary.html">org.mybatis.generator.codegen.mybatis3.xmlmapper</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/codegen/mybatis3/xmlmapper/elements/package-summary.html">org.mybatis.generator.codegen.mybatis3.xmlmapper.elements</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/config/package-summary.html">org.mybatis.generator.config</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/config/xml/package-summary.html">org.mybatis.generator.config.xml</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/exception/package-summary.html">org.mybatis.generator.exception</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/internal/package-summary.html">org.mybatis.generator.internal</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/internal/db/package-summary.html">org.mybatis.generator.internal.db</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/internal/rules/package-summary.html">org.mybatis.generator.internal.rules</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/internal/types/package-summary.html">org.mybatis.generator.internal.types</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/internal/util/package-summary.html">org.mybatis.generator.internal.util</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/internal/util/messages/package-summary.html">org.mybatis.generator.internal.util.messages</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/logging/package-summary.html">org.mybatis.generator.logging</a></li>
    <li class="api apilevel-">
  <a href="../../../../org/mybatis/generator/plugins/package-summary.html">org.mybatis.generator.plugins</a></li>
              </ul><br/>
            </div> <!-- end packages -->
          </div> <!-- end resize-packages -->
          <div id="classes-nav">
            <ul>
              
    <li><h2>Interfaces</h2>
      <ul>
          <li class="selected api apilevel-"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html">CommentGenerator</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/DAOMethodNameCalculator.html">DAOMethodNameCalculator</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/JavaFormatter.html">JavaFormatter</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/JavaTypeResolver.html">JavaTypeResolver</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/Plugin.html">Plugin</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/ProgressCallback.html">ProgressCallback</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/ShellCallback.html">ShellCallback</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/XmlFormatter.html">XmlFormatter</a></li>
      </ul>
    </li>
              
    <li><h2>Classes</h2>
      <ul>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/FullyQualifiedTable.html">FullyQualifiedTable</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/GeneratedFile.html">GeneratedFile</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/GeneratedJavaFile.html">GeneratedJavaFile</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/GeneratedXmlFile.html">GeneratedXmlFile</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/MyBatisGenerator.html">MyBatisGenerator</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/PluginAdapter.html">PluginAdapter</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/ShellRunner.html">ShellRunner</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/VerboseProgressCallback.html">VerboseProgressCallback</a></li>
      </ul>
    </li>
              
              
    <li><h2>Enums</h2>
      <ul>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/IntrospectedTable.InternalAttribute.html">IntrospectedTable.InternalAttribute</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/IntrospectedTable.TargetRuntime.html">IntrospectedTable.TargetRuntime</a></li>
          <li class="api apilevel-"><a href="../../../../org/mybatis/generator/api/Plugin.ModelClassType.html">Plugin.ModelClassType</a></li>
      </ul>
    </li>
              
              
            </ul><br/>
          </div><!-- end classes -->
        </div><!-- end nav-panels -->
        <div id="nav-tree" style="display:none">
          <div id="index-links">
            <a href="../../../../packages.html"  >Package Index</a> | 
            <a href="../../../../classes.html" >Class Index</a>
          </div>
        </div><!-- end nav-tree -->
      </div><!-- end swapper -->
    </div> <!-- end side-nav -->
    <script>
      if (!isMobile) {
        $("<a href='#' id='nav-swap' onclick='swapNav();return false;' style='font-size:10px;line-height:9px;margin-left:1em;text-decoration:none;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>").appendTo("#side-nav");
        chooseDefaultNav();
        if ($("#nav-tree").is(':visible')) {
          init_default_navtree("../../../../");
        } else {
          addLoadEvent(function() {
            scrollIntoView("packages-nav");
            scrollIntoView("classes-nav");
          });
        }
        $("#swapper").css({borderBottom:"2px solid #aaa"});
      } else {
        swapNav(); // tree view should be used on mobile
      }
    </script>



<div class="g-unit" id="doc-content">

<div id="api-info-block">




<div class="sum-details-links">


Summary:











  <a href="#pubmethods">Methods</a>
  



&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>

</div><!-- end sum-details-links -->
<div class="api-level">
  


  
  

</div>
</div><!-- end api-info-block -->


<!-- ======== START OF CLASS DATA ======== -->

<div id="jd-header">
    public
     
     
    
    interface
<h1>CommentGenerator</h1>



  
  
  


</div><!-- end header -->

<div id="naMessage"></div>

<div id="jd-content" class="api apilevel-">
<table class="jd-inheritance-table">


    <tr>
         	
        <td colspan="1" class="jd-inheritance-class-cell">org.mybatis.generator.api.CommentGenerator</td>
    </tr>
    

</table>






<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">

  <a href="#" onclick="return toggleInherited(this, null)" id="subclasses-indirect" class="jd-expando-trigger closed"
          ><img id="subclasses-indirect-trigger"
          src="../../../../../assets/images/triangle-closed.png"
          class="jd-expando-trigger-img" /></a>Known Indirect Subclasses

  <div id="subclasses-indirect">
      <div id="subclasses-indirect-list"
              class="jd-inheritedlinks"
              
              >
          
            
              <a href="../../../../org/mybatis/generator/internal/DefaultCommentGenerator.html">DefaultCommentGenerator</a>
            
          
      </div>
      <div id="subclasses-indirect-summary"
              style="display: none;"
              >
  <table class="jd-sumtable-expando">
        <tr class="alt-color api apilevel-" >
              <td class="jd-linkcol"><a href="../../../../org/mybatis/generator/internal/DefaultCommentGenerator.html">DefaultCommentGenerator</a></td>
              <td class="jd-descrcol" width="100%">&nbsp;</td>
          </tr>
  </table>
      </div>
  </div>
</td></tr></table>


<div class="jd-descr">


<h2>Class Overview</h2>
<p>Implementations of this interface are used to generate comments for the
 various artifacts.</p>





</div><!-- jd-descr -->
















<div class="jd-descr">


<h2>Summary</h2>



























<!-- ========== METHOD SUMMARY =========== -->
<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>



	 
    <tr class="alt-color api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addClassComment(org.mybatis.generator.api.dom.java.InnerClass, org.mybatis.generator.api.IntrospectedTable)">addClassComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/InnerClass.html">InnerClass</a> innerClass, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)
        
  </td></tr>


	 
    <tr class=" api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addClassComment(org.mybatis.generator.api.dom.java.InnerClass, org.mybatis.generator.api.IntrospectedTable, boolean)">addClassComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/InnerClass.html">InnerClass</a> innerClass, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, boolean markAsDoNotDelete)
        
  </td></tr>


	 
    <tr class="alt-color api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addComment(org.mybatis.generator.api.dom.xml.XmlElement)">addComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/xml/XmlElement.html">XmlElement</a> xmlElement)
        
        <div class="jd-descrdiv">This method should add a suitable comment as a child element of the
 specified xmlElement to warn users that the element was generated and is
 subject to regeneration.</div>
  
  </td></tr>


	 
    <tr class=" api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addConfigurationProperties(java.util.Properties)">addConfigurationProperties</a></span>(Properties properties)
        
        <div class="jd-descrdiv">Adds properties for this instance from any properties configured in the
 CommentGenerator configuration.</div>
  
  </td></tr>


	 
    <tr class="alt-color api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addEnumComment(org.mybatis.generator.api.dom.java.InnerEnum, org.mybatis.generator.api.IntrospectedTable)">addEnumComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/InnerEnum.html">InnerEnum</a> innerEnum, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)
        
  </td></tr>


	 
    <tr class=" api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addFieldComment(org.mybatis.generator.api.dom.java.Field, org.mybatis.generator.api.IntrospectedTable, org.mybatis.generator.api.IntrospectedColumn)">addFieldComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/Field.html">Field</a> field, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, <a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a> introspectedColumn)
        
        <div class="jd-descrdiv">This method should add a Javadoc comment to the specified field.</div>
  
  </td></tr>


	 
    <tr class="alt-color api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addFieldComment(org.mybatis.generator.api.dom.java.Field, org.mybatis.generator.api.IntrospectedTable)">addFieldComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/Field.html">Field</a> field, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)
        
  </td></tr>


	 
    <tr class=" api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addGeneralMethodComment(org.mybatis.generator.api.dom.java.Method, org.mybatis.generator.api.IntrospectedTable)">addGeneralMethodComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/Method.html">Method</a> method, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)
        
  </td></tr>


	 
    <tr class="alt-color api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addGetterComment(org.mybatis.generator.api.dom.java.Method, org.mybatis.generator.api.IntrospectedTable, org.mybatis.generator.api.IntrospectedColumn)">addGetterComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/Method.html">Method</a> method, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, <a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a> introspectedColumn)
        
  </td></tr>


	 
    <tr class=" api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addJavaFileComment(org.mybatis.generator.api.dom.java.CompilationUnit)">addJavaFileComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/CompilationUnit.html">CompilationUnit</a> compilationUnit)
        
        <div class="jd-descrdiv">This method is called to add a file level comment to a generated java
 file.</div>
  
  </td></tr>


	 
    <tr class="alt-color api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addRootComment(org.mybatis.generator.api.dom.xml.XmlElement)">addRootComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/xml/XmlElement.html">XmlElement</a> rootElement)
        
        <div class="jd-descrdiv">This method is called to add a comment as the first child of the root
 element.</div>
  
  </td></tr>


	 
    <tr class=" api apilevel-" >
        <td class="jd-typecol">
            abstract
            
            
            
            
            void
        </td>
        <td class="jd-linkcol" width="100%">
        <span class="sympad"><a href="../../../../org/mybatis/generator/api/CommentGenerator.html#addSetterComment(org.mybatis.generator.api.dom.java.Method, org.mybatis.generator.api.IntrospectedTable, org.mybatis.generator.api.IntrospectedColumn)">addSetterComment</a></span>(<a href="../../../../org/mybatis/generator/api/dom/java/Method.html">Method</a> method, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, <a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a> introspectedColumn)
        
  </td></tr>



</table>







</div><!-- jd-descr (summary) -->

<!-- Details -->








<!-- XML Attributes -->


<!-- Enum Values -->


<!-- Constants -->


<!-- Fields -->


<!-- Public ctors -->



<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- Protected ctors -->



<!-- ========= METHOD DETAIL ======== -->
<!-- Public methdos -->

<h2>Public Methods</h2>



<a id="addClassComment(org.mybatis.generator.api.dom.java.InnerClass, org.mybatis.generator.api.IntrospectedTable)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addClassComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/InnerClass.html">InnerClass</a> innerClass, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>


<a id="addClassComment(org.mybatis.generator.api.dom.java.InnerClass, org.mybatis.generator.api.IntrospectedTable, boolean)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addClassComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/InnerClass.html">InnerClass</a> innerClass, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, boolean markAsDoNotDelete)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>


<a id="addComment(org.mybatis.generator.api.dom.xml.XmlElement)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/xml/XmlElement.html">XmlElement</a> xmlElement)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p>This method should add a suitable comment as a child element of the
 specified xmlElement to warn users that the element was generated and is
 subject to regeneration.</p></div>

    </div>
</div>


<a id="addConfigurationProperties(java.util.Properties)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addConfigurationProperties</span>
      <span class="normal">(Properties properties)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p>Adds properties for this instance from any properties configured in the
 CommentGenerator configuration.
 
 This method will be called before any of the other methods.</p></div>
  <div class="jd-tagdata">
      <h5 class="jd-tagtitle">Parameters</h5>
      <table class="jd-tagtable">
        <tr>
          <th>properties</th>
          <td>All properties from the configuration
</td>
        </tr>
      </table>
  </div>

    </div>
</div>


<a id="addEnumComment(org.mybatis.generator.api.dom.java.InnerEnum, org.mybatis.generator.api.IntrospectedTable)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addEnumComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/InnerEnum.html">InnerEnum</a> innerEnum, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>


<a id="addFieldComment(org.mybatis.generator.api.dom.java.Field, org.mybatis.generator.api.IntrospectedTable, org.mybatis.generator.api.IntrospectedColumn)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addFieldComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/Field.html">Field</a> field, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, <a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a> introspectedColumn)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p>This method should add a Javadoc comment to the specified field. The
 field is related to the specified table and is used to hold the value of
 the specified column.
 <p>
 
 <b>Important:</b> This method should add a the nonstandard JavaDoc tag
 "@mbggenerated" to the comment. Without this tag, the Eclipse based Java
 merge feature will fail.</p></div>

    </div>
</div>


<a id="addFieldComment(org.mybatis.generator.api.dom.java.Field, org.mybatis.generator.api.IntrospectedTable)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addFieldComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/Field.html">Field</a> field, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>


<a id="addGeneralMethodComment(org.mybatis.generator.api.dom.java.Method, org.mybatis.generator.api.IntrospectedTable)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addGeneralMethodComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/Method.html">Method</a> method, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>


<a id="addGetterComment(org.mybatis.generator.api.dom.java.Method, org.mybatis.generator.api.IntrospectedTable, org.mybatis.generator.api.IntrospectedColumn)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addGetterComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/Method.html">Method</a> method, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, <a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a> introspectedColumn)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>


<a id="addJavaFileComment(org.mybatis.generator.api.dom.java.CompilationUnit)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addJavaFileComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/CompilationUnit.html">CompilationUnit</a> compilationUnit)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p>This method is called to add a file level comment to a generated java
 file. This method could be used to add a general file comment (such as a
 copyright notice). However, note that the Java file merge function in
 Eclipse does not deal with this comment. If you run the generator
 repeatedly, you will only retain the comment from the initial run.
 <p>
 
 The default implementation does nothing.</p></div>

    </div>
</div>


<a id="addRootComment(org.mybatis.generator.api.dom.xml.XmlElement)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addRootComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/xml/XmlElement.html">XmlElement</a> rootElement)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p>This method is called to add a comment as the first child of the root
 element. This method could be used to add a general file comment (such as
 a copyright notice). However, note that the XML file merge function does
 not deal with this comment. If you run the generator repeatedly, you will
 only retain the comment from the initial run.
 <p>
 
 The default implementation does nothing.</p></div>

    </div>
</div>


<a id="addSetterComment(org.mybatis.generator.api.dom.java.Method, org.mybatis.generator.api.IntrospectedTable, org.mybatis.generator.api.IntrospectedColumn)"></a>

<div class="jd-details api apilevel-"> 
    <h4 class="jd-details-title">
      <span class="normal">
        public 
         
         
        abstract 
         
        void
      </span>
      <span class="sympad">addSetterComment</span>
      <span class="normal">(<a href="../../../../org/mybatis/generator/api/dom/java/Method.html">Method</a> method, <a href="../../../../org/mybatis/generator/api/IntrospectedTable.html">IntrospectedTable</a> introspectedTable, <a href="../../../../org/mybatis/generator/api/IntrospectedColumn.html">IntrospectedColumn</a> introspectedColumn)</span>
    </h4>
      <div class="api-level">
        <div>

</div>
        
  

      </div>
    <div class="jd-details-descr">
      
  <div class="jd-tagdata jd-tagdescr"><p></p></div>

    </div>
</div>





<!-- ========= METHOD DETAIL ======== -->



<!-- ========= END OF CLASS DATA ========= -->
<a id="navbar_top"></a>

<div id="footer">
Generated by <a href="http://code.google.com/p/doclava/">Doclava</a>.
</div> <!-- end footer -->

</div> <!-- jd-content -->

</div><!-- end doc-content -->

</div> <!-- end body-content --> 

<script type="text/javascript">
init(); /* initialize doclava-developer-docs.js */
</script>

</body>
</html>
